feat: add TypeDoc API reference deployed to GitHub Pages#114
Merged
Conversation
Adds TypeDoc configuration and a GitHub Actions workflow that builds and deploys the API reference to https://opendecree.github.io/decree-typescript on every push to main and on version tags. The generated output goes to api-docs/ (gitignored) to avoid conflicting with the existing docs/ markdown files. All exported symbols now have TSDoc comments. GitHub Pages has been enabled on the repo via the API. Closes #10 Co-Authored-By: Claude <noreply@anthropic.com>
zeevdr
added
size: M
Bundle size
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
npm run docsruns locally and generatesapi-docs/without errorsnpm run buildstill passes (no type regressions)npx biome check --write src/reports no issuesapi-docs/is gitignored — generated output not committedbuild_type=workflow)pushtomainand onv*.*.*tags, plusworkflow_dispatchCloses #10